Skip to content

[clang][DependencyScanning] Check for the Existence of CIWithContext before Finalizing #12029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
qiongsiwu wants to merge 1 commit into
base: stable/21.x
Choose a base branch
from
Open

[clang][DependencyScanning] Check for the Existence of CIWithContext before Finalizing #12029

qiongsiwu wants to merge 1 commit into from
+12 −2

Conversation

@qiongsiwu
Copy link

@qiongsiwu qiongsiwu commented Dec 19, 2025

The by-name lookup APIs are intended for Swift. swiftlang/swift#85555 teaches Swift to use it. The original intention was to invoke the finalization API explicitly. swiftlang/swift#85555 folds the finalization step into the module dependency scanner's destructor. This leads to a case where if an initialization error occurs, the CIWithContext may not be setup for some workers, and calling the finalization API is incorrect.

This PR checks against the existence of the CIWithContext and then performs the finalization.

@qiongsiwu qiongsiwu requested a review from a team as a code owner December 19, 2025 18:55
@qiongsiwu
Copy link
Author

qiongsiwu commented Dec 19, 2025 •
edited
Loading

Note to reviewers:

  1. I don't think the current API design fits well into the use case (especially being called in the destructor of its users). I'd like to redesign the API for finalization, but I feel like that may be too much for this PR and its twin [DependencyScanning] Perform Clang Module By-Name Dependency Query Using a Shared Clang Compiler Instance swift#85555. I plan to come back to this once these two PRs land.
  2. We have test coverage for Swift https://github.com/swiftlang/swift/blob/6b3e5613203007b9a0494082b9046736e2a008b4/unittests/DependencyScan/ModuleDeps.cpp#L447 for exactly this case. That's how I discovered the problem. I will add a similar unit test case on the clang side when I refactor the API.

@qiongsiwu qiongsiwu mentioned this pull request Dec 19, 2025
Open
@qiongsiwu
Copy link
Author

qiongsiwu commented Dec 19, 2025

Please test with following PR:
swiftlang/swift#85555

@swift-ci please test

@qiongsiwu qiongsiwu requested a review from Bigcheese December 19, 2025 18:59
@qiongsiwu qiongsiwu requested a review from artemcm December 19, 2025 18:59
jansvoboda11
jansvoboda11 approved these changes Dec 19, 2025
View reviewed changes
Copy link

@jansvoboda11 jansvoboda11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. I agree that we should make the API more ergonomic.

@qiongsiwu qiongsiwu force-pushed the fix_finalization_136303612 branch from a8bf360 to 03f31d7 Compare December 21, 2025 03:24
@qiongsiwu
Copy link
Author

qiongsiwu commented Dec 21, 2025

Please test with following PR:
swiftlang/swift#85555

@swift-ci please test

@qiongsiwu
Copy link
Author

qiongsiwu commented Dec 21, 2025

Please test with following PR:
swiftlang/swift#85555

@swift-ci please test macOS.

@qiongsiwu
Copy link
Author

qiongsiwu commented Dec 21, 2025

Please test with following PR:
swiftlang/swift#85555

@swift-ci please test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@artemcm artemcm artemcm approved these changes

@jansvoboda11 jansvoboda11 jansvoboda11 approved these changes

@Bigcheese Bigcheese Awaiting requested review from Bigcheese

@cachemeifyoucan cachemeifyoucan Awaiting requested review from cachemeifyoucan

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@qiongsiwu @artemcm @jansvoboda11